Add bump-sdk skill by pietern · Pull Request #5991 · databricks/cli

pietern · 2026-07-21T08:34:08Z

Changes

Add a user-invocable bump-sdk skill that codifies the databricks-sdk-go bump workflow: resolve the SDK version (optionally from a Terraform provider's go.mod) and its paired .codegen/_openapi_sha, apply the bump, regenerate cli.json via genkit and all downstream artifacts, handle SDK breaking-change and acceptance-test fallout, verify, and add a changelog fragment.

Why

The bump has non-obvious steps that are easy to get wrong. The SDK version and the OpenAPI spec SHA must move as a pair, and the -update acceptance run can silently mask a real failure when a schema change makes the Terraform and direct engines diverge, so the skill requires a non-update verify pass to catch it. Capturing the workflow makes future bumps repeatable and keeps it consistent with the sibling bump-tf skill.

Tests

Validated by running the skill hands-off in a fresh worktree on origin/main (Terraform provider already at v1.122.0, SDK not yet bumped) to bump to v0.160.0. Its result matched the manually authored #5982 on every substantive point (resolved versions and the source-code edits), differing only where the skill correctly defers a destructive test deletion to the user.

This pull request and its description were written by Isaac.

Add a user-invocable bump-sdk skill that codifies the databricks-sdk-go bump workflow: resolve the SDK version (optionally from a Terraform provider's go.mod) and its paired .codegen/_openapi_sha, apply the bump, regenerate cli.json via genkit and all downstream artifacts, handle SDK breaking-change and acceptance-test fallout, verify, and add a changelog fragment. Consistent with the sibling bump-tf skill. Co-authored-by: Isaac

github-actions · 2026-07-21T08:34:43Z

Waiting for approval

Could not determine reviewers from git history.
Round-robin suggestion: @simonfaltum

Eligible reviewers: @andrewnester, @anton-107, @denik, @janniklasrose, @lennartkats-db, @renaudhartert-db, @shreyas-goenka, @simonfaltum

_{Suggestions based on git history. See OWNERS for ownership rules.}

eng-dev-ecosystem-bot · 2026-07-21T08:55:31Z

Integration test report

Commit: 2b378f0

Run: 29817400562

	Env	🔄flaky	💚RECOVERED	🙈SKIP	✅pass	🙈skip	Time
💚	aws linux		4	4	227	1127	3:21
💚	aws windows		4	4	229	1125	2:47
🔄	aws-ucws linux	2	4	4	312	1044	3:57
💚	aws-ucws windows		4	4	316	1042	3:30
💚	azure linux		4	4	227	1126	2:53
💚	azure windows		4	4	229	1124	3:47
💚	azure-ucws linux		4	4	316	1041	4:07
💚	azure-ucws windows		4	4	318	1039	4:41
💚	gcp linux		4	4	226	1128	2:39
💚	gcp windows		4	4	228	1126	2:25

10 interesting tests: 4 RECOVERED, 4 SKIP, 2 flaky

	Test Name	aws linux	aws windows	aws-ucws linux	aws-ucws windows	azure linux	azure windows	azure-ucws linux	azure-ucws windows	gcp linux	gcp windows
💚	TestAccept	💚R	💚R	💚R	💚R	💚R	💚R	💚R	💚R	💚R	💚R
🙈	TestAccept/bundle/invariant/no_drift	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S
🙈	TestAccept/bundle/resources/vector_search_endpoints/drift/recreated_same_name	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S
🙈	TestAccept/bundle/resources/vector_search_indexes/recreate/embedding_dimension	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S
🙈	TestAccept/ssh/connection	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S
🔄	TestFilerWorkspaceNotebook	✅p	✅p	🔄f	✅p	✅p	✅p	✅p	✅p	✅p	✅p
🔄	TestFilerWorkspaceNotebook/sqlJupyterNotebook.ipynb	✅p	✅p	🔄f	✅p	✅p	✅p	✅p	✅p	✅p	✅p
💚	TestFetchRepositoryInfoAPI_FromRepo	💚R	💚R	💚R	💚R	💚R	💚R	💚R	💚R	💚R	💚R
💚	TestFetchRepositoryInfoAPI_FromRepo/root	💚R	💚R	💚R	💚R	💚R	💚R	💚R	💚R	💚R	💚R
💚	TestFetchRepositoryInfoAPI_FromRepo/subdir	💚R	💚R	💚R	💚R	💚R	💚R	💚R	💚R	💚R	💚R

Top 1 slowest tests (at least 2 minutes):

duration	env	testname
2:11	azure-ucws windows	TestAccept/bundle/deploy/mlops-stacks/DATABRICKS_BUNDLE_ENGINE=terraform

janniklasrose · 2026-07-21T08:40:31Z

+## Steps
+
+**1. Resolve the target versions.**
+Use the SDK version the user gave, or if they want "the version the Terraform provider vX.Y.Z uses", read the provider's `go.mod` at that tag: `https://raw.githubusercontent.com/databricks/terraform-provider-databricks/vX.Y.Z/go.mod`.


the skill should look up the latest if none provided - now the step sounds like user input is required so it will ask

janniklasrose · 2026-07-21T08:42:45Z

+
+**2. Apply the core bump.**
+Run `go get github.com/databricks/databricks-sdk-go@vX.Y.Z` to update `go.mod`/`go.sum`.
+Edit `.codegen/_openapi_sha` to the new SHA; the file has no trailing newline, so match the existing format.


the file has no trailing newline, so match the existing format.

I've seen Claude struggle to maintain the format and go in a loop writing scripts to accomplish this - I'd say just

echo ${SHA} > .codegen/_openapi_sha

is sufficient since the file gets auto-formatted by generate

janniklasrose · 2026-07-21T08:51:20Z

+
+**8. Verify the rest.**
+Run `./task fmt` and `./task lint-q`; if either touches `acceptance/`, a fixture is wrong, so fix the source rather than editing output.
+Run the full root-module unit suite: `go test ./acceptance/internal ./libs/... ./internal/... ./cmd/... ./bundle/... ./experimental/... .`.


use the task?

janniklasrose · 2026-07-21T08:52:52Z

+Confirm no internal proxy URL leaked into any lock file: `./task check-uv-lock` covers `*uv.lock`, but the genkit `*.py.lock` files are outside that glob, so grep them for `pypi-proxy.cloud.databricks.com` separately.
+The `check-uv-lock` glob and the genkit lock revert are a known coverage gap; the internal proxy can re-leak into `internal/genkit/*.py.lock` on any future `generate-clijson`, so re-check after every run.


note to self: need to wrap up #5830

janniklasrose · 2026-07-21T08:55:35Z

+Add it without `(#NNNN)` now; backfill the number after the PR exists, then run `./task links` to expand it into the full markdown link in place and commit the result.
+
+**10. Commit, push, PR.**
+Pushing to `databricks/cli` requires `gh auth switch --user pietern` first, because the default gh account lacks write access.
+Then follow the `pr-checklist` skill for the PR, and do not run `gh pr create` without the user's explicit permission.
+Commit body and PR description:


we should consolidate into pr-checklist (side note: would be nice to change that skill to be a bit more instructive & make sure it's invoked - still see agents not doing it unless I ask it explicitly)

janniklasrose · 2026-07-21T08:56:13Z

+
+## Stacking and rebasing
+
+If a Terraform-provider bump PR is open and touches the same files (the bind-test `role` value and `bundle/terraform_dabs_map/generated.go`), stack on it or merge it once landed.


Suggested change

If a Terraform-provider bump PR is open and touches the same files (the bind-test `role` value and `bundle/terraform_dabs_map/generated.go`), stack on it or merge it once landed.

If a Terraform-provider bump PR is open and touches the same files (e.g. a value in `bundle/terraform_dabs_map/generated.go`), stack on it or merge it once landed.

too specific

Two fixes from a rubric evaluation against the authoring skill: - Use `./task generate-schema-map` for the DABs<->TF field map instead of a raw `go test ... -update`, and drop the incorrect "the tasks don't cover it" claim (the task wraps exactly that test), matching the bump-tf skill. - Genericize the push-auth line: a shared skill should not hardcode an individual maintainer's gh handle. Co-authored-by: Isaac

janniklasrose

tested this skill on #6098

The agent kept getting hung up on python 3.9 issues and uv not being installed, so some local tests were failing. We should improve the test harness or give it instructions to the agents here how to unblock itself

janniklasrose · 2026-07-29T14:05:32Z

+**5. Handle SDK breaking changes.**
+Read the SDK's `CHANGELOG.md` at the target version (in the module cache) to enumerate breaking changes before chasing compile errors.
+A removed struct field that the CLI used (e.g. `jobs.AiRuntimeTask.CodeSourcePath`) should have its usage temporarily disabled with a comment noting it returns in a later SDK bump, not deleted outright.
+A new struct field triggers an `exhaustruct` lint failure in `bundle/direct/dresources/*`; wire the field through `PrepareState` and `RemapState` when it exists on both the input and remote types.


Suggested change

A new struct field triggers an `exhaustruct` lint failure in `bundle/direct/dresources/*`; wire the field through `PrepareState` and `RemapState` when it exists on both the input and remote types.

A new struct field triggers an `exhaustruct` lint failure in `bundle/direct/dresources/*`. Run `./task lint` and (in case of issues) wire the field through `PrepareState` and `RemapState` when it exists on both the input and remote types.

nowhere else in the skill does it say to run lint except below where it only runs lint-q (which only lints files modified in this diff).

pietern requested review from andrewnester, denik and janniklasrose July 21, 2026 08:38

janniklasrose reviewed Jul 21, 2026

View reviewed changes

janniklasrose reviewed Jul 29, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add bump-sdk skill - #5991

Add bump-sdk skill#5991
pietern wants to merge 2 commits into
mainfrom
bump-sdk-skill

pietern commented Jul 21, 2026

Uh oh!

github-actions Bot commented Jul 21, 2026 •

edited

Loading

Uh oh!

eng-dev-ecosystem-bot commented Jul 21, 2026 •

edited

Loading

Uh oh!

janniklasrose Jul 21, 2026

Uh oh!

janniklasrose Jul 21, 2026

Uh oh!

janniklasrose Jul 21, 2026

Uh oh!

janniklasrose Jul 21, 2026

Uh oh!

janniklasrose Jul 21, 2026

Uh oh!

janniklasrose Jul 21, 2026

Uh oh!

janniklasrose left a comment

Uh oh!

janniklasrose Jul 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		Confirm no internal proxy URL leaked into any lock file: `./task check-uv-lock` covers `uv.lock`, but the genkit `.py.lock` files are outside that glob, so grep them for `pypi-proxy.cloud.databricks.com` separately.
		The `check-uv-lock` glob and the genkit lock revert are a known coverage gap; the internal proxy can re-leak into `internal/genkit/*.py.lock` on any future `generate-clijson`, so re-check after every run.


		## Stacking and rebasing

		If a Terraform-provider bump PR is open and touches the same files (the bind-test `role` value and `bundle/terraform_dabs_map/generated.go`), stack on it or merge it once landed.

	A new struct field triggers an `exhaustruct` lint failure in `bundle/direct/dresources/*`; wire the field through `PrepareState` and `RemapState` when it exists on both the input and remote types.
	A new struct field triggers an `exhaustruct` lint failure in `bundle/direct/dresources/*`. Run `./task lint` and (in case of issues) wire the field through `PrepareState` and `RemapState` when it exists on both the input and remote types.

Uh oh!

Conversation

pietern commented Jul 21, 2026

Changes

Why

Tests

Uh oh!

github-actions Bot commented Jul 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Waiting for approval

Uh oh!

eng-dev-ecosystem-bot commented Jul 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Integration test report

Uh oh!

janniklasrose Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

janniklasrose Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

janniklasrose Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

janniklasrose Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

janniklasrose Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

janniklasrose Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

janniklasrose left a comment

Choose a reason for hiding this comment

Uh oh!

janniklasrose Jul 29, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented Jul 21, 2026 •

edited

Loading

eng-dev-ecosystem-bot commented Jul 21, 2026 •

edited

Loading